Appendix C - Song Field Request Options
Field Tag
When requesting a list of songs to be returned, the <fields> tag is used to indicate what song fields you would like to have included.
<fields> <field id="101" /> <field name="Title" /> </fields>
The fields section must contain one field tag for each song field you wish to include in the reply message. You can use the id attribute with the internal field ID codes, or a name attribute with the user-specified field name. You can obtain a list of available fields with the command.
In addition to the normal fields, a special field 100 is available. When specified, the song “description" is returned, which includes the user-selected primary and secondary fields.
For multiple keyword fields, you can add the keyword attribute that allows you to select a specific keyword from the list. This example shows how to get the first two keywords from a field.
<fields> <field id="101" /> <field name="Artist Keywords" keyword="1" /> <field name="Artist Keywords" keyword="2" /> </fields>
You can also use the trivia attribute to return song or keyword trivia lines. This example shows how to retrieve the active trivia for the song, and the fixed trivia lines for the specified Artist Keyword.
<fields> <field id="100" trivia="active" /> <field name="Artist Keywords" keyword="1" trivia="fixed" /> </fields>
The options for the trivia attribute are fixed (all fixed trivia lines only), rotate (the next available rotating trivia line), and active (The active fixed lines and next rotating line).
Script Tag
A script function option is available for any field. You can include a script tag that includes a script function like the ones that can be used in the standard log export design editor and other places in MusicMaster. This can allow you to have some data formatting done before the information is returned by Nexus.
<fields> <field id="100" script="mm.GetFieldEx(101,",")" /> </fields>
userData
A "userData" attribute is available on <field> tags. Whether you are requesting a field by ID or name, you can include userData with any value and that value will be passed through to be included in the Reply field tag. This may be useful when you are requesting multiple values from the same field. This would allow you to tell them apart in the reply. In the example reply below, one is returned with "PrimaryKeyword" in the reply tag. This is optional.
<fields>
<field id="101" />
<field name="Artist Keywords" keyword="1" userData="PrimaryKeyword" />
<field name="Artist Keywords" keyword="2" />
</fields>
Compatibility and Version Info
These additional options were added along with MusicMaster PRO 4.0sr12.
userData added with MusicMaster PRO 7.0.09.